/*******************************************************************************
 * Copyright (C) Marvell International Ltd. and its affiliates
 *
 * This software file (the "File") is owned and distributed by Marvell
 * International Ltd. and/or its affiliates ("Marvell") under the following
 * alternative licensing terms.  Once you have made an election to distribute the
 * File under one of the following license alternatives, please (i) delete this
 * introductory statement regarding license alternatives, (ii) delete the three
 * license alternatives that you have not elected to use and (iii) preserve the
 * Marvell copyright notice above.
 *
 ********************************************************************************
 * Marvell Commercial License Option
 *
 * If you received this File from Marvell and you have entered into a commercial
 * license agreement (a "Commercial License") with Marvell, the File is licensed
 * to you under the terms of the applicable Commercial License.
 *
 ********************************************************************************
 * Marvell GPL License Option
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File in accordance with the terms and conditions of the General
 * Public License Version 2, June 1991 (the "GPL License"), a copy of which is
 * available along with the File in the license.txt file or by writing to the Free
 * Software Foundation, Inc., or on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
 * DISCLAIMED.  The GPL License provides additional details about this warranty
 * disclaimer.
 *
 ********************************************************************************
 * Marvell GNU General Public License FreeRTOS Exception
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File in accordance with the terms and conditions of the Lesser
 * General Public License Version 2.1 plus the following FreeRTOS exception.
 * An independent module is a module which is not derived from or based on
 * FreeRTOS.
 * Clause 1:
 * Linking FreeRTOS statically or dynamically with other modules is making a
 * combined work based on FreeRTOS. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 * As a special exception, the copyright holder of FreeRTOS gives you permission
 * to link FreeRTOS with independent modules that communicate with FreeRTOS solely
 * through the FreeRTOS API interface, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting combined work
 * under terms of your choice, provided that:
 * 1. Every copy of the combined work is accompanied by a written statement that
 * details to the recipient the version of FreeRTOS used and an offer by yourself
 * to provide the FreeRTOS source code (including any modifications you may have
 * made) should the recipient request it.
 * 2. The combined work is not itself an RTOS, scheduler, kernel or related
 * product.
 * 3. The independent modules add significant and primary functionality to
 * FreeRTOS and do not merely extend the existing functionality already present in
 * FreeRTOS.
 * Clause 2:
 * FreeRTOS may not be used for any competitive or comparative purpose, including
 * the publication of any form of run time or compile time metric, without the
 * express permission of Real Time Engineers Ltd. (this is the norm within the
 * industry and is intended to ensure information accuracy).
 *
 ********************************************************************************
 * Marvell BSD License Option
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File under the following licensing terms.
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *	* Redistributions of source code must retain the above copyright notice,
 *	  this list of conditions and the following disclaimer.
 *
 *	* Redistributions in binary form must reproduce the above copyright
 *	  notice, this list of conditions and the following disclaimer in the
 *	  documentation and/or other materials provided with the distribution.
 *
 *	* Neither the name of Marvell nor the names of its contributors may be
 *	  used to endorse or promote products derived from this software without
 *	  specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *******************************************************************************/

#ifndef __mv_stack_h__
#define __mv_stack_h__

/* includes */
#include <stdbool.h>
#include <string.h>
#include <stdio.h>

#include "mv_std.h"

/* LIFO Stack implementation */

/**
 * Stack instance structure
 */
struct mv_stack {
	int stack_idx;		/**< index of next free place in the stack */
	int num_of_elements;	/**< maximum number of elements can be pushed to stack */
	void **stack_elements;	/**< array of elements in the stack */
};

/**
 *  Check if the stack is full
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	true	- stack is full
 * @retval	false	- stack is not full
 */
static inline bool mv_stack_is_full(struct mv_stack *stack)
{
	if (stack->stack_idx == stack->num_of_elements)
		return true;

	return false;
}

/**
 *  Check if the stack is empty
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	true	- stack is empty
 * @retval	false	- stack is not empty
 */
static inline bool mv_stack_is_empty(struct mv_stack *stack)
{
	if (stack->stack_idx == 0)
		return true;

	return false;
}

/**
 *  Push new element to the stack
 *
 * @param[in]	stack	  - stack handler.
 * @param[in]	value	  - value to be pushed to the stack.
 *
 * @retval	0         - Success. New element was added to the stack.
 * @retval	Negative  - Failure. Stack is full.
 */
static inline int mv_stack_push(struct mv_stack *stack, void *value)
{
	if (stack->stack_idx == stack->num_of_elements) {
		pr_err("%s: Stack is FULL\n", __func__);
		return -1;
	}

	stack->stack_elements[stack->stack_idx] = value;
	stack->stack_idx++;
	return 0;
}

/**
 *  Pop element from the top of the stack
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	value   - Success. Returned element is removed from the stack.
 * @retval	NULL	- Failure. Stack is empty.
 */
static inline void *mv_stack_pop(struct mv_stack *stack)
{
	if (stack->stack_idx == 0) {
		pr_debug("%s: Stack is EMPTY\n", __func__);
		return NULL;
	}

	stack->stack_idx--;
	return stack->stack_elements[stack->stack_idx];
}

/**
 *  Get number of elements in the stack
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	value   - Number of elements stored in the stack.
 */
static inline int mv_stack_elements(struct mv_stack *stack)
{
	return stack->stack_idx;
}

/**
 *  Get number of free places in the stack
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	value   - Number of free places in the stack.
 */
static inline int mv_stack_free_elements(struct mv_stack *stack)
{
	return stack->num_of_elements - stack->stack_idx;
}

/**
 *  Create new stack instance
 *
 * @param[in]	num_of_elements - maximum number of elements in the stack.
 * @param[out]	stack		- address of place to save handler of new created stack instance.
 *
 * @retval	0         - success
 * @retval	Negative  - failure
 */
int mv_stack_create(int num_of_elements, struct mv_stack **stack);

/**
 * Delete stack instance
 *
 * @param[in]	stack	  - stack handler.
 *
 * @retval	0         - success
 * @retval	Negative  - failure
 */
int mv_stack_delete(struct mv_stack *stack);

#endif /* __mv_stack_h__ */
